updated intro page for SGW #885
Conversation
This requires ui prod-213, and an asciidoc hack with empty section to close out the previous flex basis :sadpanda:
There was a problem hiding this comment.
This all looks technically correct to me from a developer perspective.
There are a few things I would rather not highlight on the starting page, such as Indexing vs Views. Is the intention to have a full TOC on the starting page, or just show common and useful information?
If the intention is to show useful information, I will have more comments. If the intention is to be a TOC of all the stuff in the sidebar, then some sections are missing. e.g. Deploy in the sidebar has more items than in the main page.
| * xref:rest-api-access.adoc[] | ||
| * xref:rest-api-admin.adoc[] | ||
| * xref:rest-api-metrics.adoc[] |
There was a problem hiding this comment.
This is ultimately a question for docs team but since we switched from swagger to redocly, some of these pages are really just pass through to openapi and have actually no content
This definitely could be outside the scope of this review, I was just testing the links here.
If there's extra information on any of these pages. I find it annoying as a consumer of the docs to be sent to https://preview.docs-test.couchbase.com/docs-sync-gateway-DOC-13353-update-SGW-intro-page/sync-gateway/current/rest-api.html only to have to click through to https://preview.docs-test.couchbase.com/docs-sync-gateway-DOC-13353-update-SGW-intro-page/sync-gateway/current/rest_api_public.html
The same is true for admin and metrics.
|
At a high level, I think the links part after Getting Started, this overlaps with Start Here: Quick Links, what's the plan there? Perhaps we either remove Quick Links or move the overview links pat there? I think the overview introduction bit is more comprehensive than before. We spoke about bringing back the diagram as it is useful for users to reason about how Sync Gateway fits into the Couchbase ecosystem and what is purpose is as a component. |
Docs Issue: DOC-13353
Docs Preview: URL
You will need the Docs Team credentials on Confluence.